home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 1 / Cream of the Crop 1.iso / MONITOR / TXTSHW30.ARJ / TEXTSHOW.DOC < prev    next >
Text File  |  1991-04-12  |  24KB  |  539 lines
  1.                     ********************************
  2.                     *        TEXT-SHOW 3.0         *
  3.                     *       ShareWare Version      *
  4.                     *   Documentation/Information  *
  5.                     ********************************
  6.  
  7. OVERVIEW:
  8. =========
  9.  
  10. TEXT-SHOW is a highly stylized screen presentation program from DECISIONS
  11. Software of Phoenix, Arizona.  The program allows the user to create customized
  12. screen presentations using text screens saved or captured with the included
  13. TXTCAP.COM resident screen capture utility.  TEXT-SHOW features include
  14. multiple screen fades and segues, special screen effects, text display using
  15. customized and computer fonts, border and screen clearing effects and more.
  16.  
  17. The text screen is one of the may be used by any computer system, with or
  18. without a color monitor and/or graphics card.  The program will run on any IBM
  19. compatible computer with a minimum of 256K of RAM memory.
  20.  
  21. The files included in this ShareWare version are:
  22.  
  23.                 TXSHO3.EXE       -  The Text-Show program
  24.                 TEXTSHOW.SPT     -  Demonstration Script File
  25.                 TEXTSHOW.DOC     -  This documentation file
  26.                 TXTCAP.COM       -  Screen Capture Program
  27.                 WMTELL*.COM      -  Sample Music Files
  28.                 ORDER.FRM        -  Order Form
  29.                 *.SCR            -  Several captured screen files
  30.                                     used in the demo Text-Show
  31.                                     script.
  32.  
  33. TEXT-SHOW Demonstration Show
  34. ===========================
  35.  
  36. A demonstration of many of the features of TEXT-SHOW is included in this
  37. ShareWare version.  To view the demo, change to the directory where the
  38. TEXT-SHOW files are stored.  From that directory type  TXSHO3  at the DOS
  39. prompt and press the Enter key.  A brief ShareWare screen will appear.  In a
  40. few seconds, the demonstration program will begin.
  41.  
  42.  
  43. TEXT-SHOW SHAREWARE VERSION
  44. ==========================
  45.  
  46. The ShareWare concept is quite simple.  Try out TEXT-SHOW for a short period
  47. of time (30 days maximum).  If you would like to order TEXT-SHOW, simply send
  48. in the Registration/Order form included with this file (ORDER.FRM) along with
  49. your payment.  If not, erase the files, discontinuing all use of the program.
  50.  
  51. The ShareWare version of TEXT-SHOW is identical to the registered version with
  52. a few exceptions.
  53.  
  54.         1.  A brief ShareWare screen appears at the beginning and end of each
  55.         session of TEXT-SHOW.  These screens are removed in the registered
  56.         version.
  57.  
  58.         2.  The registered version includes a professionally printed and bound
  59.         user manual.  The documentation in this manual is more in depth.
  60.  
  61.         3.  The registered version comes with Run-Time Modules which allow you
  62.         unlimited distribution of shows you create with TEXT-SHOW with no
  63.         royalties or fees.
  64.  
  65.  
  66. Page 2.
  67.         
  68.  
  69. REGISTRATION/ORDER INFORMATION
  70. ==============================
  71.  
  72. We plan to continually add to and improve the TEXT-SHOW series of programs.
  73. Plans call for adding new and unique screen fades/segues, allow for user
  74. queries, and so forth.  Registration will guarantee that you receive the
  75. latest version of TEXT-SHOW and associated files and that you will be notified
  76. as each update is available.
  77.  
  78. We have included a form for your use in ordering TEXT-SHOW.  The order form is
  79. contained in the file  ORDER.FRM  and is stored as simple ASCII text.  You may
  80. print this form on your line printer.  To print, first log on to the
  81. drive/directory where the order form file is located.  Be sure your printer is
  82. turned on and ready to print.  At the DOS prompt type:
  83.  
  84.                 TYPE ORDER.FRM>PRN
  85.  
  86. and press the Enter key.  You may also load and print the form from any
  87. editor/word processor that accepts and prints ASCII text files.
  88.  
  89. Once you've printed the form, fill out the information requested and return
  90. along with your payment to the address indicated and we'll rush you your
  91. registered version of TEXT-SHOW.
  92.  
  93. All orders and inquiries should be directed to:
  94.  
  95.         DECISIONS Software
  96.         P.O. Box 31418
  97.         Phoenix, AZ  85046
  98.         (602)-992-0310
  99.  
  100.  
  101. HARDWARE REQUIREMENTS:
  102. ======================
  103.  
  104. Minimum hardware requirements for using TEXT-SHOW are an IBM compatible
  105. computer, DOS 2.xx or higher, 256K RAM memory and a monitor.
  106.  
  107. Page 3.
  108.  
  109. USING TEXT-SHOW
  110. ==============
  111.  
  112. This ShareWare documentation file contains information on how to use TEXT-SHOW
  113. to create your own customized screen presentations.  It covers each of the
  114. features available in TEXT-SHOW.  In-depth explanations and tutorials are
  115. included in the printed and bound manual that accompanies the registered
  116. version but are not included in this ShareWare documentation.  We do provide
  117. you, however, with all the information needed to tryout and use every feature
  118. available in TEXT-SHOW.
  119.  
  120. If you haven't viewed the demonstration of TEXT-SHOW yet, we suggest you do so
  121. before continuing with this documentation.  The demo will give you a good
  122. overview of the capabilities of the program.  To see the demo show, change to
  123. the directory where you have installed your TEXT-SHOW files.  At the DOS
  124. prompt type:
  125.  
  126.                         TXSHO3
  127.  
  128. and press the Enter key.  The program will load and run the demonstration
  129. files.
  130.  
  131. A.  VIDEO MODE:  TEXT-SHOW uses the standard ASCII text mode of your computer.
  132. While not required, presentations may be viewed on systems that contain CGA,
  133. EGA, VGA and Super VGA graphics cards.  It is important to have an
  134. understanding of how TEXT-SHOW stores and displays screen files.
  135.  
  136. To accomplish the nifty screen fades and segues, TEXT-SHOW must store at least
  137. one screen file in background memory while displaying another visual (or
  138. foreground) screen.  The number of screens you store in the background at any
  139. one time depends on the memory available to your system.  To use the features
  140. of the program, you only need memory for two screens. . . the foreground,
  141. visible screen and one background screen.
  142.  
  143. There is NO limit to the total number of screen files you may use in a
  144. presentation.  For those with limited memory, we have included a CLEAR
  145. command.  When you have displayed a screen you may clear the memory that was
  146. required for its display and then load a new screen file.  You will notice in
  147. the demo that we load up to 5 screens at any one time.  This is the maximum
  148. amount that may be in memory in this ShareWare version.  To load more, simply
  149. load new screens in one of the 5 screen slots.  The size of each captured
  150. screen file is 4007 bytes.
  151.  Page 4.
  152.  
  153. HOW TEXT-SHOW WORKS
  154. ==================
  155.  
  156. You interface your captured text screens with TEXT-SHOW using a proprietary
  157. Script format.  The Script format is simply a set of one or two word commands
  158. that tells TEXT-SHOW what you want to do.  An example of a Script file is the
  159. demonstration file  TEXTSHOW.SPT.  Take a look at this file in any editor/word
  160. processor that is able to load and read ASCII based text files.
  161.  
  162. Once you have created or captured the text screens you wish to include, you
  163. need to tell TEXT-SHOW when and how you want them displayed.  You may also use
  164. the Script to display text (using custom or computer fonts), clear screens or
  165. draw screen borders, pop up windows/boxes, make sounds, etc.
  166.  
  167. You may create the Script in any editor/word processor that can save a file in
  168. standard ASCII format.  Once you've completed your Script you can name it using
  169. any conventional DOS characters.  To see the show at the DOS prompt you would
  170. type:
  171.  
  172.                         TXSHO3 [Filename.Ext]
  173.  
  174. and then press the Enter key.  The Script file and TXSHO3.EXE file must be in
  175. the same drive/directory.  If no file name is given when TXSHO3 is entered at
  176. the DOS prompt, the program looks for a default file named TEXTSHOW.SPT.
  177. That's what we named our demo Script. If TEXT-SHOW can't find the Script file
  178. it will tell you.
  179.  
  180. Let's say you created a Script file named MYSHOW.SHW and you want to view the
  181. show.  From the DOS prompt you type:
  182.  
  183.                        TXSHO3 MYSHOW.SHW
  184.  
  185. and press the Enter key.  Be sure there is a space between TXSHO3 and your
  186. Script file name.  You may, of course, add to, change or delete lines/commands
  187. in your Script file at any time.
  188.  
  189.  
  190. SCRIPT COMMANDS
  191. ===============
  192.  
  193. The following is a review of all the Script commands available in TEXT-SHOW.
  194. Script files may be prepared in any editor/word processor that is able to save
  195. files in the ASCII format.  Each Script command must be on a separate line.
  196. Any combination of upper and lower case letters are allowed.  The proper syntax
  197. outlined below must be followed.
  198.  
  199. We have grouped the commands in six main categories.  They are:
  200.  
  201.         1.  File Commands
  202.         2.  Fades, Segues & Effects
  203.         3.  Clearing the Screen
  204.         4.  BIG Fonts
  205.         5.  Text Display
  206.         6.  Miscellanous Commands
  207.  
  208. Page 5.
  209.  
  210. 1.  File Commands:  There are three file commands.  They are LOAD, CLEAR and
  211. SEND.
  212.  
  213. LOAD [Filename.Ext] [Number]
  214. ----------------------------
  215. This script command is used to load a SCR screen file.  The LOAD command is
  216. followed by the filename and extension.  Finally, you must assign that file a
  217. number.  For example, if you wanted to load a SCR file named MYFILE and assign
  218. it as file number one the syntax would be:  LOAD MYFILE.SCR 1
  219.  
  220. You may also designate a drive and directory if your SCR file is not in the
  221. same directory as the TXTSHO.EXE program.  For example, if your file is located
  222. on drive C in a directory named SCRPICS, then the proper syntax would be:
  223. LOAD C:\SCRPICS\MYFILE.SCR 1
  224.  
  225. Be sure there is a space between each element of the command.  The LOAD command
  226. does not display the file on screen, but simply sends the information to
  227. memory.  To display a file, you use the SEND and FADES script commands after
  228. the LOAD command.
  229.  
  230. CLEAR
  231. --------------
  232. This command is the opposite of the LOAD command.  It removes all SCR screen
  233. file information from memory.  It does not affect the display screen.
  234.  
  235. SEND [Number]
  236. -------------
  237. This command identifies the loaded SCR screen file you wish to manipulate by
  238. it's number.  The SEND command is used just prior to identifying how you want
  239. the screen displayed.  The actual command to display the screen is the FADES
  240. command.  We will next examine the multiple fades available in the category
  241. named Fades & Seques.
  242.       
  243. 2.  Fades, Seques & Effects:  These commands actually display's your loaded
  244. SCR screen file on to your screen.  There are two commands in this category.
  245. They are FADES & SHAKE.   The proper syntax for the FADES command is:
  246.  
  247. FADES [Number]
  248. --------------
  249. There are 17 possible fade/segue numbers that follow the FADES command.  Here
  250. is a list of the screen fade numbers and the type of fade/segue it invokes.
  251.  
  252.  1 -  Explode
  253.  2 -  Slide Left
  254.  3 -  Slide Right
  255.  4 -  Slide Up
  256.  5 -  Slide Down
  257.  6 -  Horizontal Blinds
  258.  7 -  Puzzle Pieces
  259.  8 -  Radar Sweep
  260.  9 -  Page Roll
  261. 10 -  Vertical Blinds
  262. 11 -  Window Wipe
  263. 12 -  Fast Dissolve
  264. 13 -  Slow Dissolve
  265. 14 -  Open Curtain
  266. 15 -  Close Curtain
  267. 16 -  Side Wipe
  268. 17 -  Instant On (Entire Screen appears instantaneously)
  269.  
  270. Page 6.
  271.  
  272. 18 -  Vertical Split
  273. 19 -  Squeeze
  274. 20 -  Snake
  275. 21 -  Pour Top To Bottom
  276.  
  277.  
  278. SHAKE [Seconds]
  279. ---------------
  280. The SHAKE command is a special effects script command.  It will shake your
  281. video display for the number of seconds you wish.  View the demo to see how we
  282. used this special effects command.
  283.  
  284. 3.  Clearing the Screen:  There are two commands in this category.  They are
  285. CLS and SEND 6.  The proper syntax for CLS is:
  286.  
  287. CLS
  288. ---
  289. The CLS script command clears the screen.  It fills the screen with blank
  290. characters. You may designate colors for the screen with the COLOR command
  291. discussed next.
  292.  
  293. COLOR [Foreground Color Number,Background Color Number]
  294. -------------------------------------------------------
  295. The color command is used for foreground and background color of the screen.
  296. For example, the script command COLOR 15,4 would display any text in white
  297. letters on a red background.
  298.  
  299. The following list contains the Color Numbers used in TEXT-SHOW.
  300.  
  301.     0 - Black      4 - Red        8 - Dark Gray       12 - Bright Red
  302.     1 - Blue       5 - Purple     9 - Bright Blue     13 - Bright Purple
  303.     2 - Green      6 - Brown     10 - Bright Green    14 - Yellow
  304.     3 - Cyan       7 - Gray      11 - Bright Cyan     15 - White
  305.  
  306. To invoke blinking simply add 16 to the number in the chart above.  For
  307. example, the script command COLOR 31,4 would display any text in blinking
  308. white letters on a red background.
  309.  
  310.  
  311. Page 7.
  312.  
  313. SEND 6
  314. ------
  315. This command will send blank characters to memory.  You then may use any of
  316. the 17 fades with the FADES command to clear the screen using the fade effect.
  317.  
  318. 5.  Text Display:  TEXT-SHOW features the ability to display any text you wish
  319. to add to any screen.  The text may be in your resident computer font or in the
  320. custom BIG Font supplied with TEXT-SHOW.
  321.  
  322. For your resident computer font there are two script commands used to display
  323. the desired text and an optional color command.  They commands are:
  324.  
  325. COLOR [Foreground Color Number,Background Color Number]
  326. -----------------------------
  327. The color command is used for foreground and background color of the text.  The
  328. colors may be different than the screen color (For color selection numbers see
  329. the color chart above).  For example, the script command COLOR 15,4 would
  330. display any text in white letters on a red background.
  331.  
  332. AT [Row, Column]
  333. ----------------
  334. The AT script command places the desired text to begin at a specific screen row
  335. and screen column.  There are 25 rows and 80 columns on each screen.  If you
  336. wanted a line of text to appear in the upper left hand corner you would enter
  337. the following script command:  AT 1,1
  338.  
  339. PRINT ["Text"]
  340. --------------
  341. This is the script command that actually displays the text on your screen.
  342. Your text must be enclosed by quotation marks.  Example:  If you wanted to
  343. enter text that said ACME Widgets Budget Review the proper syntax would be:
  344. PRINT "ACME Widgets Budget Review"
  345.  
  346. TEXT-SHOW also lets you display custom Big Fonts.  These would mainly be used
  347. for titles and special effects.  The commands for display text in this font
  348. are similar to the commands above.
  349.  
  350. BCOL [Foreground Color Number]
  351. -------------------------------------------------------
  352. Big Fonts use the current background color of the screen. You must designate
  353. the foreground color of the font text using the color chart.  A special color
  354. number of -1 (negative one) is used when you desire a multi-colored font.
  355.  
  356. BAT [Row Word,Column Word]
  357. -----------------------------
  358. The BAT script command is identical to the AT command.
  359.  
  360. BPRNT ["Text"]
  361. --------------
  362. This is the script command that actually displays the custom font text on your
  363. screen. Your text must be enclosed by quotation marks.  Example:  If you wanted
  364. to enter text that said ACME Widgets Budget Review the proper syntax would be:
  365. FPRNT "ACME Widgets Budget Review"
  366.  
  367. BCHR [ASCII Character Number]
  368. -----------------------------
  369. This command allows you to display your Big Font using any of the 255 ASCII
  370. Characters.  See the demo script for sample characters.
  371.  
  372. Page 8.
  373.  
  374. BWID [Number]
  375. -------------
  376. This will adjust the size of the Big Font.  One is a normally Big Font.  Two
  377. is a Huge Font.
  378.  
  379. 6.  Miscellanous Script Commands
  380.  
  381. MOUSE [On/Off]:
  382. ---------------
  383. If you have a mouse active on your computer you may use it as a pointer and a
  384. remote control device.  To activate the mouse the proper syntax is MOUSE ON.
  385. When you turn the mouse on, a cursor will appear in the upper right hand
  386. corner of your screen.  You may then move the cursor on your screen as you
  387. move your mouse.  To make the cursor disappear the proper syntax is MOUSE OFF.
  388.  
  389. If the mouse is connected, you may use it as a remote control device wether or
  390. not the pointer is displayed.  Clicking the right and center mouse buttons move
  391. forward one screen.  Clicking the left mouse button will end the show.
  392.  
  393. DELAY [Seconds]
  394. ---------------
  395. You may create a designated delay between screens by using the DELAY script
  396. command.  If you wanted to delay 3 seconds between screen actions the proper
  397. syntax would be:  DELAY 3
  398.  
  399. PAUSE
  400. -----
  401. Pause is similar to delay except that a key press or mouse click is required
  402. for the show to continue.  Pressing the left mouse key or the Esc keyboard key
  403. will terminate the show.  Pressing any other key will move forward to the next
  404. script command.
  405.  
  406. LOOP
  407. ----
  408. If you wish to redisplay the entire show from the beginning without having to
  409. rerun TEXT-SHOW you would use the LOOP command.  This will start the show over
  410. from the very beginning.  In the ShareWare version, this means from the opening
  411. ShareWare screen.  In the registered version, this means from the first command
  412. in your script file.
  413.  
  414. BORDER [ASCII Character Number]
  415. --------------------------------
  416. You may draw a border around any screen with the BORDER script command.  You
  417. may also choose a color for that border using the color chart listed earlier in
  418. this documentation.  To draw a single line border on your screen the proper
  419. syntax would be:  BORDER 1  To draw a double line border the proper syntax
  420. would be BORDER 2.  To draw a border comprised of ASCII Character 219 the
  421. proper syntax would be BORDER 219.
  422.  
  423. Page 9
  424.  
  425. BOX [Row Begin,Column Begin,Row End,Column End,Character #]
  426. ------------------------------------------------------------
  427. You may create Pop-Up windows/boxes using this script command. There are five
  428. (5) parameters that must be entered.  Row Begin is the upper left corner of
  429. where you want the box displayed; Column Begin is the beginning column number;
  430. Row End is the lower portion of the box; Column End is the ending column number
  431. of the box. Character # is used to designate the type of frame you wish to
  432. display.  You may use any of the ASCII 255 characters as this number.
  433. Character numbers 1-4 are special designated characters. They are as follows:
  434.  
  435.         1 = Single Line Frame                3 = Double/Single Mixed Frame
  436.         2 = Double Line Frame                4 = Single/Double Mixed Frame
  437.  
  438. To designate the color of the box, you first would issue the COLOR script
  439. command.  The first number (foreground) represents the color of the frame and
  440. the second number (background) represents the color of the box.  For example,
  441. if you wish to draw a red Pop-Up box with a white double line frame beginning
  442. at Row 10, Column 10 and ending at Row 15, Column 40, the proper script
  443. commands are:
  444.  
  445. COLOR 15,4
  446. BOX 10,10,15,40,2
  447.  
  448. Please view the demo TEXT-SHOW script (TEXTSHOW.SPT) for more examples on using
  449. and drawing Pop-Up boxes/windows.
  450.  
  451.  
  452. PAINT [Row Begin,Column Begin,Row End,Column End]
  453. -------------------------------------------------
  454. This is similar to the BOX command, except that the purpose is to re-color the
  455. current screen without destroying the display.  The parameters needed are the
  456. same as mentioned above.  The paint color is set by using the COLOR script
  457. command.  For example, if you wished to paint the top half of the screen with
  458. white characters on a red background the commands would be:
  459.  
  460. COLOR 15,4
  461. PAINT 1,1,12,80
  462.  
  463. See the demo script TEXTSHOW.SPT for more examples on using the PAINT command.
  464.  
  465. SOUND [Number]
  466. --------------
  467. You may use this command when you desire a sound to highlight a screen or
  468. message.  There are five distinct sounds included in this version of TEXT-SHOW.
  469. All sounds are relatively short in duration. The number following the Sound
  470. script command must be between 1 and 5.
  471.  
  472. RUN [Filename.Extension]
  473. ------------------------
  474. This command is a built in shell feature of TEXT-SHOW and may be used to run
  475. other executable (.EXE or .COM) programs without disturbing your screen
  476. presentation in TEXT-SHOW.  This command was originally created to allow users
  477. to play music while a screen from TEXT-SHOW appears on the monitor.  The demo
  478. script, TEXTSHOW.SPT, gives an example of using the RUN command in this
  479. fashion.  You may also use the command to run any program.  When the shelled
  480. program ends, you are returned to your TEXT-SHOW where you left off.  For
  481. example, if you wish to run a program named EXAMPLE.COM from within your
  482. TEXT-SHOW, the proper syntax would be:  RUN EXAMPLE.COM.  Be sure there is a
  483. space between the command RUN and the full filename of the program.
  484.  
  485. Page 10
  486. ----------
  487. TXTCAP.COM
  488. ----------
  489.  
  490. TXTCAP.COM is memory resident screen capture program.  The purpose of this
  491. program is to capture any text screen you can display on your monitor in the
  492. Bload, Text-Show, SCR file format.
  493.  
  494. To use this program, simply type TXTCAP.COM at the DOS prompt.  You will see a
  495. brief message appear on your screen.  The message tells you that the program
  496. has been loaded, is memory resident and may be invoked by pressing the Ctrl-F9
  497. key combination.
  498.  
  499. HOW TO CAPTURE SCREENS:  When you have a text screen displayed that you wish
  500. to capture, press the Ctrl-F9 key combination (while holding down the Ctrl
  501. key press the F9 function key).  A prompt will appear at the upper left hand
  502. corner of your screen.  This prompt asks you to enter a filename.  The
  503. filename must contain no more than 8 valid DOS filename characters and should
  504. be followed with a SCR extension.  After you have entered the filename, press
  505. the Enter key.  The program will then capture the graphics screen in SCR
  506. Text-Show file format.  The captured file will reside in the current drive and
  507. directory.
  508.  
  509. If after pressing the Ctrl-F9 key combination you determine that you really
  510. don't want to save the screen, simply press the Esc key.  Your screen will
  511. return and the file will NOT be saved.
  512.  
  513. To remove the ScreenCapture program from memory, simply type  TXTCAP /U
  514. at the DOS prompt and press the Enter key.  This will unload (remove) the
  515. program from memory, i.e., it will no longer be memory resident.
  516.  
  517.  
  518. OTHER PROGRAMS FROM DECISIONS
  519. =============================
  520. DECISIONS Software also offers PCX-SHOW & Utilities.  PCX-SHOW is a graphic
  521. screen presentation program using the PCX file format.  Like TEXT-SHOW, it uses
  522. multiple screen fades, seques and special effects but the screens it displays
  523. are EGA/VGA graphic screens.  The program comes with a series of PCX file
  524. utilities including a graphics screen capture program; a utility that converts
  525. an ASCII screen to a graphics screen and saves it in PCX format; a PCX file
  526. viewing/printing program and more.  See the file ORDER.FRM for details.
  527.  
  528.  
  529. DISCLAIMER
  530. ==========
  531. TEXT-SHOW is a copyrighted program of Decisions Software of Phoenix, Arizona.
  532. These programs are provided "as is" without warranty of any kind, either
  533. expressed or implied, including but not limited to the implied warranties of
  534. merchantability and fitness for a particular purpose. Decisions Software and
  535. it's employees shall have no responsibility or liability to you or any other
  536. person, persons, or entity with respect to loss or damage caused or alleged to
  537. be caused directly or indirectly by use of these programs or their
  538. documentation.
  539.